<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="prod_tt_sasportal_v1alpha1.html">SAS Portal API (Testing)</a> . <a href="prod_tt_sasportal_v1alpha1.customers.html">customers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="prod_tt_sasportal_v1alpha1.customers.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>

<p class="toc_element">
  <code><a href="prod_tt_sasportal_v1alpha1.customers.devices.html">devices()</a></code>
</p>
<p class="firstline">Returns the devices Resource.</p>

<p class="toc_element">
  <code><a href="prod_tt_sasportal_v1alpha1.customers.nodes.html">nodes()</a></code>
</p>
<p class="firstline">Returns the nodes Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a requested customer.</p>
<p class="toc_element">
  <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of requested customers.</p>
<p class="toc_element">
  <code><a href="#listGcpProjectDeployments">listGcpProjectDeployments(x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of SAS deployments associated with current GCP project. Includes whether SAS analytics has been enabled or not.</p>
<p class="toc_element">
  <code><a href="#listLegacyOrganizations">listLegacyOrganizations(x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of legacy organizations.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#migrateOrganization">migrateOrganization(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing customer.</p>
<p class="toc_element">
  <code><a href="#provisionDeployment">provisionDeployment(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.</p>
<p class="toc_element">
  <code><a href="#setupSasAnalytics">setupSasAnalytics(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Returns a requested customer.

Args:
  name: string, Required. The name of the customer. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Entity representing a SAS customer.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
  &quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns a list of requested customers.

Args:
  pageSize: integer, The maximum number of customers to return in the response.
  pageToken: string, A pagination token returned from a previous call to ListCustomers that indicates where this listing should continue from.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for `ListCustomers`.
  &quot;customers&quot;: [ # The list of customers that match the request.
    { # Entity representing a SAS customer.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
      &quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.
}</pre>
</div>

<div class="method">
    <code class="details" id="listGcpProjectDeployments">listGcpProjectDeployments(x__xgafv=None)</code>
  <pre>Returns a list of SAS deployments associated with current GCP project. Includes whether SAS analytics has been enabled or not.

Args:
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for [ListGcpProjectDeployments].
  &quot;deployments&quot;: [ # Optional. Deployments associated with the GCP project
    { # Deployment associated with the GCP project. Includes whether SAS analytics has been enabled or not.
      &quot;deployment&quot;: { # The Deployment. # Deployment associated with the GCP project.
        &quot;displayName&quot;: &quot;A String&quot;, # The deployment&#x27;s display name.
        &quot;frns&quot;: [ # Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.
          &quot;A String&quot;,
        ],
        &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name.
        &quot;sasUserIds&quot;: [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.
          &quot;A String&quot;,
        ],
      },
      &quot;hasEnabledAnalytics&quot;: True or False, # Whether SAS analytics has been enabled.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="listLegacyOrganizations">listLegacyOrganizations(x__xgafv=None)</code>
  <pre>Returns a list of legacy organizations.

Args:
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for [ListLegacyOrganizations]. [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations].
  &quot;organizations&quot;: [ # Optional. Legacy SAS organizations.
    { # Organization details.
      &quot;displayName&quot;: &quot;A String&quot;, # Name of organization
      &quot;id&quot;: &quot;A String&quot;, # Id of organization
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="migrateOrganization">migrateOrganization(body=None, x__xgafv=None)</code>
  <pre>Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller&#x27;s GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects.
  &quot;organizationId&quot;: &quot;A String&quot;, # Required. Id of the SAS organization to be migrated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an existing customer.

Args:
  name: string, Output only. Resource name of the customer. (required)
  body: object, The request body.
    The object takes the form of:

{ # Entity representing a SAS customer.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
  &quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
    &quot;A String&quot;,
  ],
}

  updateMask: string, Fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Entity representing a SAS customer.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Name of the organization that the customer entity represents.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the customer.
  &quot;sasUserIds&quot;: [ # User IDs used by the devices belonging to this customer.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="provisionDeployment">provisionDeployment(body=None, x__xgafv=None)</code>
  <pre>Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP Project, Organization Info, and caller’s GAIA ID should be retrieved from the RPC handler, and used as inputs to create a new SAS organization (if not exists) and a new SAS deployment.
  &quot;newDeploymentDisplayName&quot;: &quot;A String&quot;, # Optional. If this field is set, and a new SAS Portal Deployment needs to be created, its display name will be set to the value of this field.
  &quot;newOrganizationDisplayName&quot;: &quot;A String&quot;, # Optional. If this field is set, and a new SAS Portal Organization needs to be created, its display name will be set to the value of this field.
  &quot;organizationId&quot;: &quot;A String&quot;, # Optional. If this field is set then a new deployment will be created under the organization specified by this id.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment].
  &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. Optional error message if the provisioning request is not successful.
}</pre>
</div>

<div class="method">
    <code class="details" id="setupSasAnalytics">setupSasAnalytics(body=None, x__xgafv=None)</code>
  <pre>Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request for the SetupSasAnalytics rpc.
  &quot;userId&quot;: &quot;A String&quot;, # Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>